Skip to content

Update SAML authentication settings

Request

Modifies SAML authentication settings.

Security
ApiKeyAuth
Path
subdomainstringrequired

Unique subdomain of requested Hub.

Query
api_versionstring

Api version

Value:"V3-R1"
Bodyapplication/json
enabledboolean
idp_metadatastring or null

IdP SAML metadata in XML format.

Example:"<?xml version=\"1.0\"?>\n<md:EntityDescriptor\n xmlns:md=\"urn:oasis:names:tc:SAML:2.0:metadata\"\n entityID=\"https://some-idp.company.com/\"\n>\n
sloboolean

Controls if SLO should be used when signing-out from Hub:

  • true - SLO is enabled. This requires SingleLogoutService configuration to be included in idp_metadata,
  • false - SLO is not enabled.
debugboolean or null

Controls verbosity of SAML error page:

  • true - Show detailed error message,
  • false - Show generic error message without details.
sign_out_targetstring or null, (uri)

Location where user will be redirected after successful sign-out.

curl -i -X PUT \
  'https://subdomain-of-your-account.app.statushub.io/api/v3/hubs/{subdomain}/access_restriction/saml?api_version=V3-R1' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "enabled": true,
    "idp_metadata": "<?xml version=\"1.0\"?>\n<md:EntityDescriptor\n  xmlns:md=\"urn:oasis:names:tc:SAML:2.0:metadata\"\n  entityID=\"https://some-idp.company.com/\"\n>\n...\n</md:EntityDescriptor>\n",
    "slo": true,
    "debug": true,
    "sign_out_target": "http://example.com"
  }'

Responses

OK

Bodyapplication/json
enabledboolean
idp_metadatastring or null

IdP SAML metadata in XML format.

Example:"<?xml version=\"1.0\"?>\n<md:EntityDescriptor\n xmlns:md=\"urn:oasis:names:tc:SAML:2.0:metadata\"\n entityID=\"https://some-idp.company.com/\"\n>\n
debugboolean

Controls verbosity of SAML error page:

  • true - Show detailed error message,
  • false - Show generic error message without details.
sign_out_targetstring or null, (uri)

Location where user will be redirected after successful sign-out.

sloboolean

Controls if SLO should be used when signing-out from Hub:

  • true - SLO is enabled. This requires SingleLogoutService configuration to be included in idp_metadata,
  • false - SLO is not enabled.
sp_dataobject

Informational field.
Returns identifiers and URL that can be used to setup SAML connection.

Response
{
  "enabled": true,
  "idp_metadata": "<?xml version=\"1.0\"?>\n<md:EntityDescriptor\n  xmlns:md=\"urn:oasis:names:tc:SAML:2.0:metadata\"\n  entityID=\"https://some-idp.company.com/\"\n>\n...\n</md:EntityDescriptor>\n",
  "debug": true,
  "sign_out_target": "http://example.com",
  "slo": true,
  "sp_data": {
    "certificate_url": "http://example.com",
    "metadata_url": "http://example.com",
    "entity_id": "http://example.com",
    "sso_url": "http://example.com",
    "slo_url": "http://example.com"
  }
}